Rework Fake.Core.Target package #1664

devcrafting · 2017-09-18T05:55:45Z

**/!\ There is a breaking change with NuGet package rename to be consistent between Nuget package and namespace

Documentation improved (I reordered paragraphs to put important notes first)
Add more Obsolete messages in TargetHelper and AdditionalSyntax (including 2 new codes for "not yet migrated" and "no more accessible")
Remove remaning "Target" suffix
Rename Print in ListAvailable

matthid · 2017-09-18T16:45:16Z

Apparently this needs a merge/rebase after the latest PR merges, sorry.

matthid

Nice - thanks for helping out with this.

matthid · 2017-09-18T16:46:27Z

help/markdown/fake-migrate-to-fake-5.md


 ## Migration Guide

-Upgrading to FAKE 5 is a multi step process and has various manual steps in between. Here are the steps:
+Upgrading to FAKE 5 is a multi step process and has various manual steps in between. **If you do these steps out of order it will be a lot harder for you to migrate the script successfully**. Here are the steps:


Good point.

matthid · 2017-09-18T16:50:18Z

src/app/Fake.Core.Target/Target.fs

-        getTargetDict().Values
-          |> Seq.iter (fun target ->
-                Trace.tracefn "  - %s %s" target.Name (match target.Description with Some d -> " - " + d | _ -> "")
-                Trace.tracefn "     Depends on: %A" target.Dependencies)


Nice catch.

- Consistent naming between namespace & NuGet pagckage - Introduce FAKE003 code for functions made unaccessible - Review all documentation referencing Target

…accordingly

devcrafting · 2017-09-18T18:22:31Z

Rebase done (someone already fixed doc around Target)

devcrafting · 2017-09-22T08:51:00Z

Any chance to have a look at this PR @matthid ? Thanks

matthid · 2017-09-22T09:44:48Z

Yes I'm kind of slow at the moment. next step is to release all the stuff I've merged and update to netcoreapp20 and fixing the release pipeline (some things are not yet automated - see fake.api.github pr). Than I can test the release pipeline for example with this pr

matthid

👍

matthid · 2017-09-22T15:30:52Z

build-web-bundles.fsx

@@ -57,4 +57,4 @@ Target "Default" DoNothing
    ==> "Default"

 // start build
-RunParameterTargetOrDefault "target" "Default"
+RunTargetOrDefault "Default"


Target.RunParameterOrDefault or Target.RunOrDefault?

Yes I like your suggestion...I will do it and normalize casing in a new PR, do you agree?

actually I was wrong on this. I have no idea where this file is used and if updating this breaks anything...

I was thinking you were saying that RunParameterOrDefault would be a better name than just RunOrDefault?

No your change is fine. I'm not sure why we even have runparameterordefault

matthid · 2017-09-22T15:31:35Z

help/markdown/contributing.md

+    - FAKE0001 for moving part from one Module to another
+    - FAKE0002 for removed API we don't know who is using it and how => please open an issue if you use it
+    - FAKE0003 for API that is no more accessible (basically became internal) => please open an issue if you use it
+    - FAKE0004 for API not yet migrated, waiting for your contribution


Oh nice idea.

matthid · 2017-09-22T15:32:24Z

help/markdown/core-targets.md

@@ -53,27 +53,27 @@ Now we have the following options:
 ## Final targets

 Final targets can be used for TearDown functionality. 
-These targets will be executed even if the build fails but have to be activated via ActivateFinalTarget().
+These targets will be executed even if the build fails but have to be activated via ActivateFinal().


Should we write Target.ActivateFinal here to advertise the new usage?

matthid · 2017-09-22T15:32:38Z

help/markdown/core-targets.md


-	BuildFailureTarget "ReportErrorViaMail" (fun _ ->
+	CreateBuildFailure "ReportErrorViaMail" (fun _ ->


matthid · 2017-09-22T15:32:43Z

help/markdown/core-targets.md

-	// Activate BuildFailureTarget somewhere during build
-	ActivateBuildFailureTarget "ReportErrorViaMail"
+	// Activate Build Failure Target somewhere during build
+	ActivateBuildFailure "ReportErrorViaMail"


matthid · 2017-09-22T15:33:06Z

help/markdown/fake-commandline.md



 	"Clean"
 	  ==> "Build"
 	  ==> "Deploy"

-	RunTargetOrDefault "Deploy"
+	Target.RunOrDefault "Deploy"


matthid · 2017-09-22T15:34:14Z

help/markdown/fake-migrate-to-fake-5.md

- Fix all the (obsolete) warnings in your build-script to use the new API (see the 'Use the new FAKE-API' section).
+- Update to legacy FAKE 5. This should not be breaking. If it breaks you please open an issue.
+
+  - With Paket: add `prerelease` after `nuget FAKE` in paket.dependencies file then `.paket/paket.exe update FAKE`, check that paket.lock references FAKE version 5 


We may need to remember to remove prerelease after releasing FAKE.

matthid · 2017-09-24T15:12:50Z

Ok I've merged this into #1678 if you want to push additional changes please use a new branch/PR if possible. Thanks.

GitHub should merge/close this PR as soon as #1678 is merged.

devcrafting changed the title ~~[WIP] Reword Fake.Core.Target package~~ [WIP] Rework Fake.Core.Target package Sep 18, 2017

matthid approved these changes Sep 18, 2017

View reviewed changes

devcrafting added 8 commits September 18, 2017 20:13

Reorder text and add anchor links in migration guide

bbfefb5

Review Fake.Core.Target module naming + doc

1b40731

- Consistent naming between namespace & NuGet pagckage - Introduce FAKE003 code for functions made unaccessible - Review all documentation referencing Target

Improve migration and contributing doc

2c14e9b

Replace Print with ListAvailable

1858aba

Rename Print in ListAvailable + remove "Target" suffix + update docs …

5271233

…accordingly

Put Obsolete attributes in AdditionalSyntax (=> TargetOperators)

95014c2

Update Final and BuildFailure targets doc

a5fc7cb

Add "not yet migrated" obsolete attributes

b474d43

devcrafting force-pushed the feature/migration-improvements branch from 954d16d to b474d43 Compare September 18, 2017 18:21

devcrafting changed the title ~~[WIP] Rework Fake.Core.Target package~~ Rework Fake.Core.Target package Sep 18, 2017

devcrafting added 3 commits September 18, 2017 20:26

Add a comment about partial fix of warnings

ea42789

Fix merge (forget to save during rebase...)

ba4a4ba

Add Obsolete doc for Target templating

a48b02e

matthid approved these changes Sep 22, 2017

View reviewed changes

matthid merged commit a48b02e into fsprojects:master Sep 25, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework Fake.Core.Target package #1664

Rework Fake.Core.Target package #1664

devcrafting commented Sep 18, 2017

matthid commented Sep 18, 2017

matthid left a comment

matthid Sep 18, 2017

matthid Sep 18, 2017

devcrafting commented Sep 18, 2017

devcrafting commented Sep 22, 2017

matthid commented Sep 22, 2017

matthid left a comment

matthid Sep 22, 2017

matthid Sep 24, 2017

devcrafting Sep 27, 2017

matthid Sep 27, 2017

devcrafting Sep 27, 2017

matthid Sep 27, 2017

matthid Sep 22, 2017

matthid Sep 22, 2017

matthid Sep 24, 2017

matthid Sep 22, 2017

matthid Sep 24, 2017

matthid Sep 22, 2017

matthid Sep 24, 2017

matthid Sep 22, 2017

matthid Sep 22, 2017

matthid commented Sep 24, 2017


		BuildFailureTarget "ReportErrorViaMail" (fun _ ->
		CreateBuildFailure "ReportErrorViaMail" (fun _ ->

Rework Fake.Core.Target package #1664

Rework Fake.Core.Target package #1664

Conversation

devcrafting commented Sep 18, 2017

matthid commented Sep 18, 2017

matthid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devcrafting commented Sep 18, 2017

devcrafting commented Sep 22, 2017

matthid commented Sep 22, 2017

matthid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthid commented Sep 24, 2017